/*
 * File Name     : @(#)GenericIdPlaceHolder.java
 * Creation Date : Mar 2, 2009
 * Author        : anirudh
 * 
 * Copyright 2009 Anirudh Vyas
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package hcis.core.engine.constant.placeholder.impl;

import hcis.core.engine.constant.placeholder.IConstantPlaceHolder;
import hcis.model.annotation.HCISEntity;

/**
 * Default Id constant place holder. Holds Id constants that can be re-used.
 * 
 * @author avyas
 */
@HCISEntity
public enum GenericIdPlaceHolder implements IConstantPlaceHolder<Long> {

	/**
	 * Group Id constant.
	 */
	GROUP_ID(1000L),

	/**
	 * Mock account id for usage.
	 */
	MOCK_ACCOUNT_ID(1L);

	/**
	 * Value of the underlying constant.
	 */
	private Long value;

	/**
	 * Default constructor, sets the value of the constant.
	 * 
	 * @param pValue
	 *            value to set.
	 */
	private GenericIdPlaceHolder(final Long pValue) {
		setValue(pValue);
	}

	/**
	 * {@inheritDoc}
	 */
	public final Long getValue() {
		return value;
	}

	/**
	 * {@inheritDoc}
	 */
	public final void setValue(final Long pValue) {
		value = pValue;
	}
}
